FamiPay

FamiPay API一覧

HTTP仕様（.idPass）

HTTP仕様（.json）

Request header
Content-Type: application/x-www-form-urlencoded;charset=windows-31j
Method
POST
Response header
Content-Type: text/plain;charset=windows-31j
Status Code
200：常に200を返却
Request header
Content-Type: application/json;charset=UTF-8
Method
POST
Response header
Content-Type: application/json;charset=UTF-8
Status Code
  • 200：正常時
  • 400：入力パラメータエラー、加盟店設定エラー
  • 500：システムエラー
  • 502：決済エラー
　　　　　　　
    ※以下のエラーコードはhttp200で返却される可能性がございます。
    　 ・E90010001
    　 ・E92000001
    　 ・E92000002
    　 ・E91099996
    　 ・E91099997

EntryTranFamipay 取引登録

これ以降の決済取引で必要となる取引IDと取引パスワードの発行を行い、取引を開始します。

リクエスト
ShopID shopID 必須 半角英数13桁
ショップID

ShopPass shopPass 必須 半角英数64桁
ショップパスワード

OrderID orderID 必須 半角英数記号27桁
オーダーID

Amount amount 必須 半角数字6桁
利用金額

Tax tax 半角数字6桁
税送料

URL
/payment/EntryTranFamipay.json
リクエストパラメータ
{
  "shopID": "tshop11223344",
  "shopPass": "PASSWORD",
  "orderID": "ORDER0000001",
  "amount": "100"
}
URL
/payment/EntryTranFamipay.idPass
リクエストパラメータ
ShopID=tshop11223344&ShopPass=PASSWORD&OrderID=ORDER0000001&Amount=100
レスポンス
正常
AccessID accessID 半角英数32桁 固定
取引ID

AccessPass accessPass 半角英数32桁 固定
取引パスワード

異常
ErrCode errCode 半角英数3桁 固定
エラーコード
ErrInfo errInfo 半角英数9桁 固定
エラー詳細コード
レスポンスパラメータ：正常系
{
  "accessID": "a6a6b0061347e90cdef806b39bd28705",
  "accessPass": "5e0e54b892e14ed03e8cf807a6053813"
}
レスポンスパラメータ：正常系
AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813
レスポンスパラメータ：異常系
{
    "errCode":"E01",
    "errInfo":"E01040001"
}
レスポンスパラメータ：異常系
ErrCode=E01&ErrInfo=E01040001

ExecTranFamipay 決済実行

これ以降の決済取引で必要となるトークンを返却します。

リクエスト
ShopID shopID 必須 半角英数13桁
ショップID

ShopPass shopPass 必須 半角英数64桁
ショップパスワード

AccessID accessID 必須 半角英数32桁 固定
取引ID

AccessPass accessPass 必須 半角英数32桁 固定
取引パスワード

OrderID orderID 必須 半角英数記号27桁
オーダーID

ClientField1 clientField1 全半角100バイト
加盟店自由項目1

ClientField2 clientField2 全半角100バイト
加盟店自由項目2

ClientField3 clientField3 全半角100バイト
加盟店自由項目3

RetURL retURL 必須 半角英数記号256桁
決済結果戻しURL

加盟店様が当サービスからの決済結果を受信する為の結果受信URLを設定します。
弊社画面上でお客様が支払操作をキャンセルした場合や、当サービスにて決済処理を実行した場合に指定されたURLに結果をリダイレクト経由で送信されます。

AuthToken authToken 半角英数記号256桁
認証連携トークン

SSO連携をする場合に設定する認証用トークンです。一部の加盟店様がご利用する際に使用します。

URL
/payment/ExecTranFamipay.json
リクエストパラメータ
{
  "shopID": "tshop11223344",
  "shopPass": "PASSWORD",
  "accessID": "a6a6b0061347e90cdef806b39bd28705",
  "accessPass": "5e0e54b892e14ed03e8cf807a6053813",
  "orderID": "ORDER0000001",
  "retURL": "https://example.com/receive/success"
}
URL
/payment/ExecTranFamipay.idPass
リクエストパラメータ
ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001&RetURL=https://example.com/receive/success
レスポンス
正常
AccessID accessID 半角英数32桁 固定
取引ID

Token token 半角英数記号256桁
トークン

StartURL startURL 半角英数記号256桁
支払手続き開始IFのURL

異常
ErrCode errCode 半角英数3桁 固定
エラーコード
ErrInfo errInfo 半角英数9桁 固定
エラー詳細コード
レスポンスパラメータ：正常系
{
  "accessID": "a6a6b0061347e90cdef806b39bd28705",
  "token": "qlxcMlmNXu+YJoAPr0zIiHoG/KrcaJJkTVUEeuYe67E3Vh427rKZBJphG0D2YhAL",
  "startURL": "https://x01.xxxx/payment/FamipayStart.idPass"
}
レスポンスパラメータ：正常系
AccessID=a6a6b0061347e90cdef806b39bd28705&Token=qlxcMlmNXu+YJoAPr0zIiHoG/KrcaJJkTVUEeuYe67E3Vh427rKZBJphG0D2YhAL&StartURL=https://x01.xxxx/payment/FamipayStart.idPass
レスポンスパラメータ：異常系
{
    "errCode":"E01",
    "errInfo":"E01040001"
}
レスポンスパラメータ：異常系
ErrCode=E01&ErrInfo=E01040001

FamipayStart 支払手続き開始

FamiPayにおいて、お客様をFamiPayログイン画面へと遷移させる必要があります。

リクエスト
AccessID 必須 半角英数32桁 固定
取引ID

Token 必須 半角英数記号256桁
トークン

【決済実行】で発行された値を設定します。

URL
/payment/FamipayStart.idPass
リクエストパラメータ
AccessID=a6a6b0061347e90cdef806b39bd28705&Token=qlxcMlmNXu+YJoAPr0zIiHoG/KrcaJJkTVUEeuYe67E3Vh427rKZBJphG0D2YhAL
リクエストパラメータ

				<head>
				  <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
					</head>
				  <body OnLoad='OnLoadEvent();'>
					<form name="FamipayStartCall" action="{決済実行のレスポンスで返却した接続先URL}" method="POST">
						<noscript>
							<br>
							<br>
							<center>
								<h2>FamiPayの決済画面へ遷移します。</h2>
								<input type="submit" value="続行">
							</div>
						</noscript>
						<input type="hidden" name="AccessID" value="{AccessID}">
						<input type="hidden" name="Token" value="{Token}">
					</form>
					<script>
				<!--
				function OnLoadEvent() {
				document.FamipayStartCall.submit();
				}
				//-->
					</script>
				  </body>
				</html>

リダイレクト後、お客様はFamiPayログイン画面へ遷移します。

決済結果受信

当サービスは、お客様が支払操作を完了または中止した際に、決済実行時に指定された決済結果戻しURLに結果を通知します。

レスポンス
正常
ShopID 半角英数13桁
ショップID

OrderID 半角英数記号27桁
オーダーID

Status
現状態

以下のステータスが返却されます。
・PAYSUCCESS：決済成功
・PAYFAIL：決済失敗

TranDate 半角数字14桁 固定
処理日時

yyyy/MM/dd HH:mm:ss書式

UriageNO 半角数字12桁
売上No

FamiPayで取引を特定するための番号を返却します。

CheckString 半角英数記号32桁
改ざんチェック文字列

OrderID、AccessID、ShopID、ShopPassを連結しMD5ハッシュした値を返却します。

異常
ErrCode 半角英数3桁 固定
エラーコード
ErrInfo 半角英数9桁 固定
エラー詳細コード

FamipayCancel キャンセル

対象の取引をキャンセルします。

リクエスト
ShopID shopID 必須 半角英数13桁
ショップID

ShopPass shopPass 必須 半角英数64桁
ショップパスワード

AccessID accessID 必須 半角英数32桁 固定
取引ID

AccessPass accessPass 必須 半角英数32桁 固定
取引パスワード

OrderID orderID 必須 半角英数記号27桁
オーダーID

URL
/payment/FamipayCancel.json
リクエストパラメータ
{
  "shopID": "tshop11223344",
  "shopPass": "PASSWORD",
  "accessID": "a6a6b0061347e90cdef806b39bd28705",
  "accessPass": "5e0e54b892e14ed03e8cf807a6053813",
  "orderID": "ORDER0000001"
}
URL
/payment/FamipayCancel.idPass
リクエストパラメータ
ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001
レスポンス
正常
OrderID orderID 半角英数記号27桁
オーダーID

Status status
現状態

成功時は以下のステータスが返却されます。
CANCEL

異常
ErrCode errCode 半角英数3桁 固定
エラーコード
ErrInfo errInfo 半角英数9桁 固定
エラー詳細コード
レスポンスパラメータ：正常系
{
  "orderID": "ORDER0000001",
  "status": "CANCEL"
}
レスポンスパラメータ：正常系
OrderID=ORDER0000001&Status=CANCEL
レスポンスパラメータ：異常系
{
    "errCode":"E01",
    "errInfo":"E01040001"
}
レスポンスパラメータ：異常系
ErrCode=E01&ErrInfo=E01040001

SearchTradeMulti 取引状態参照

対象取引の取引状態を取得します※idPass版にのみ対応しています。json版には対応していません。

リクエスト
ShopID 必須 半角英数13桁
ショップID

ShopPass 必須 半角英数64桁
ショップパスワード

OrderID 必須 半角英数記号27桁
オーダーID

PayType 必須 半角数字2桁 固定
決済方法

39：FamiPay

URL
/payment/SearchTradeMulti.idPass
リクエストパラメータ
ShopID=tshop11223344&ShopPass=PASSWORD&OrderID=ORDER0000001&PayType=39
レスポンス
正常
Status
現状態

UNPROCESSED：未決済
REQSUCCESS：要求成功
AUTHPROCESS：認証処理中
PAYSUCCESS：実売上
CANCEL：キャンセル
PAYFAIL：決済失敗
EXPIRED：期限切れ

ProcessDate 半角数字14桁 固定
処理日時

yyyyMMddHHmmss書式

AccessID 半角英数32桁 固定
取引ID

AccessPass 半角英数32桁 固定
取引パスワード

Amount 半角数字10桁
利用金額

Tax 半角数字10桁
税送料

ClientField1 全半角100バイト
加盟店自由項目1

ClientField2 全半角100バイト
加盟店自由項目2

ClientField3 全半角100バイト
加盟店自由項目3

PayType 半角数字2桁 固定
決済方法

39：FamiPay

UriageNO 半角英数12桁
売上No

FamiPayで取引を特定するための番号を返却します。

AuthToken 半角英数記号256桁
認証連携トークン

異常
ErrCode 半角英数3桁 固定
エラーコード
ErrInfo 半角英数9桁 固定
エラー詳細コード
レスポンスパラメータ：正常系
Status=PAYSUCCESS&ProcessDate=20201225091313&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&Amount=100&Tax=8&ClientField1=加盟店自由項目1&ClientField2=加盟店自由項目2&ClientField3=加盟店自由項目3&PayType=39&UriageNO=123456789012&AuthToken=
レスポンスパラメータ：異常系
ErrCode=E01&ErrInfo=E01040001